-
Notifications
You must be signed in to change notification settings - Fork 169
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Replace frigate with helm-docs #160
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In principal I am good with this change .. however.. the rendered output does not show and description anymore.. I am hoping we can somehow make the docs for all the values more useful. Can we somehow fix this?
In fact I am contemplating adding a website similar to how we just got it added in the Trino Gateway repo .. so we can write some useful docs for the charts that go beyond what we have in the Trino docs themselves.
Also .. if helm-docs is good .. we want to look at adding its usage for the Trino Gateway chart in the trino-gateway repo. |
cb4071e
to
d570154
Compare
@mosabua I've used a custom template to print all values as a definition list instead of a table. I included those large examples that wouldn't fit in the table well. I also filled in most descriptions with links to Kubernetes and Trino documentation, where relevant. Please review. |
dd2c8f4
to
79fbcc0
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a massive improvement. I think we should merge and then we can refine more going forward in terms of specific wording other nits in separate PRs.
Avoid trailing comments, move them to a separate line
Use
pre-commit
so developers can use a git hook to regenerate docs.I replaced
frigate
withhelm-docs
because frigate's pre-commit hook requiresconda
to install it.helm-docs
run from a Docker container.Also update all GitHub actions and enable Dependabot.